<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cr-rgb: Libcroco Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libcroco Reference Manual">
<link rel="up" href="ch01.html" title="Extensive APIs description">
<link rel="prev" href="libcroco-cr-pseudo.html" title="cr-pseudo">
<link rel="next" href="libcroco-cr-sel-eng.html" title="cr-sel-eng">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libcroco-cr-rgb.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libcroco-cr-pseudo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libcroco-cr-sel-eng.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libcroco-cr-rgb"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcroco-cr-rgb.top_of_page"></a>cr-rgb</span></h2>
<p>cr-rgb</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libcroco-cr-rgb.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-new" title="cr_rgb_new ()">cr_rgb_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-new-with-vals" title="cr_rgb_new_with_vals ()">cr_rgb_new_with_vals</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-parse-from-buf" title="cr_rgb_parse_from_buf ()">cr_rgb_parse_from_buf</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-compute-from-percentage" title="cr_rgb_compute_from_percentage ()">cr_rgb_compute_from_percentage</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-set" title="cr_rgb_set ()">cr_rgb_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-copy" title="cr_rgb_copy ()">cr_rgb_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-to-inherit" title="cr_rgb_set_to_inherit ()">cr_rgb_set_to_inherit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-is-set-to-inherit" title="cr_rgb_is_set_to_inherit ()">cr_rgb_is_set_to_inherit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-is-set-to-transparent" title="cr_rgb_is_set_to_transparent ()">cr_rgb_is_set_to_transparent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-to-transparent" title="cr_rgb_set_to_transparent ()">cr_rgb_set_to_transparent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-rgb" title="cr_rgb_set_from_rgb ()">cr_rgb_set_from_rgb</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-name" title="cr_rgb_set_from_name ()">cr_rgb_set_from_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-hex-str" title="cr_rgb_set_from_hex_str ()">cr_rgb_set_from_hex_str</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-set-from-term" title="cr_rgb_set_from_term ()">cr_rgb_set_from_term</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-to-string" title="cr_rgb_to_string ()">cr_rgb_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-dump" title="cr_rgb_dump ()">cr_rgb_dump</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libcroco-cr-rgb.html#cr-rgb-destroy" title="cr_rgb_destroy ()">cr_rgb_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-rgb.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb">CRRgb</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libcroco-cr-rgb.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libcroco-cr-rgb.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cr-rgb-new"></a><h3>cr_rgb_new ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> *
cr_rgb_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>The default constructor of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p>
<p>Returns the newly built instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a></p>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-new-with-vals"></a><h3>cr_rgb_new_with_vals ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> *
cr_rgb_new_with_vals (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_red</code></em>,
                      <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_green</code></em>,
                      <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_blue</code></em>,
                      <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_percentage</code></em>);</pre>
<p>A constructor of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p>
<p>Returns the newly built instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.16.6.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_red</p></td>
<td class="parameter_description"><p>the red component of the color.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_green</p></td>
<td class="parameter_description"><p>the green component of the color.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_blue</p></td>
<td class="parameter_description"><p>the blue component of the color.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_unit</p></td>
<td class="parameter_description"><p>the unit of the rgb values.
(either percentage or integer values)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-parse-from-buf"></a><h3>cr_rgb_parse_from_buf ()</h3>
<pre class="programlisting"><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="returnvalue">CRRgb</span></a> *
cr_rgb_parse_from_buf (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_str</code></em>,
                       <em class="parameter"><code><span class="type">enum CREncoding</span> a_enc</code></em>);</pre>
<p>Parses a text buffer that contains a rgb color</p>
<p>Returns the parsed color, or NULL in case of error</p>
<div class="refsect3">
<a name="id-1.2.16.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_str</p></td>
<td class="parameter_description"><p>a string that contains a color description</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_enc</p></td>
<td class="parameter_description"><p>the encoding of a_str</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-compute-from-percentage"></a><h3>cr_rgb_compute_from_percentage ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_compute_from_percentage (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>);</pre>
<p>If the rgb values are expressed in percentage,
compute their real value.</p>
<p>Returns CR_OK upon successful completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set"></a><h3>cr_rgb_set ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_set (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
            <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_red</code></em>,
            <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_green</code></em>,
            <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> a_blue</code></em>,
            <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_percentage</code></em>);</pre>
<p>Sets rgb values to the RGB.</p>
<p>Returns CR_OK upon successful completion, an error code
otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_red</p></td>
<td class="parameter_description"><p>the red value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_green</p></td>
<td class="parameter_description"><p>the green value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_blue</p></td>
<td class="parameter_description"><p>the blue value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-copy"></a><h3>cr_rgb_copy ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_copy (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_dest</code></em>,
             <em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_src</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-to-inherit"></a><h3>cr_rgb_set_to_inherit ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_set_to_inherit (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
                       <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_inherit</code></em>);</pre>
<p>sets the value of the rgb to inherit.
Look at the css spec from chapter 6.1 to 6.2 to understand
the meaning of "inherit".</p>
<p>Returns CR_OK upon succesful completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-is-set-to-inherit"></a><h3>cr_rgb_is_set_to_inherit ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
cr_rgb_is_set_to_inherit (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);</pre>
<p><em class="parameter"><code>a_this</code></em>
: the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p>
<p>Returns TRUE if the rgb is set to the value "inherit", FALSE otherwise.</p>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-is-set-to-transparent"></a><h3>cr_rgb_is_set_to_transparent ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
cr_rgb_is_set_to_transparent (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);</pre>
<p>Tests if the the rgb is set to the
value "transparent" or not.</p>
<p>Returns TRUE if the rgb has been set to
transparent, FALSE otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.10.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of
<a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-to-transparent"></a><h3>cr_rgb_set_to_transparent ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_set_to_transparent (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
                           <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> a_is_transparent</code></em>);</pre>
<p>Sets the rgb to the "transparent" value (or not)
Returns CR_OK upon successfull completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_is_transparent</p></td>
<td class="parameter_description"><p>set to transparent or not.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-rgb"></a><h3>cr_rgb_set_from_rgb ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_set_from_rgb (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
                     <em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_rgb</code></em>);</pre>
<p>Sets the rgb from an other one.</p>
<p>Returns CR_OK upon successful completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.12.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_rgb</p></td>
<td class="parameter_description"><p>the rgb to "copy"</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-name"></a><h3>cr_rgb_set_from_name ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_set_from_name (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
                      <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_color_name</code></em>);</pre>
<p>Returns CR_OK upon successful completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_color_name</p></td>
<td class="parameter_description"><p>the color name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-hex-str"></a><h3>cr_rgb_set_from_hex_str ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_set_from_hex_str (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
                         <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *a_hex_value</code></em>);</pre>
<p>Returns CR_OK upon successful completion.</p>
<div class="refsect3">
<a name="id-1.2.16.6.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_hex</p></td>
<td class="parameter_description"><p>the hexadecimal value to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-set-from-term"></a><h3>cr_rgb_set_from_term ()</h3>
<pre class="programlisting">enum <a class="link" href="libcroco-cr-utils.html#CRStatus" title="enum CRStatus"><span class="returnvalue">CRStatus</span></a>
cr_rgb_set_from_term (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>,
                      <em class="parameter"><code>const <span class="type">struct _CRTerm</span> *a_value</code></em>);</pre>
<p>Set the rgb from a terminal symbol</p>
<p>Returns CR_OK upon successful completion, an error code otherwise.</p>
<div class="refsect3">
<a name="id-1.2.16.6.15.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_value</p></td>
<td class="parameter_description"><p>the terminal from which to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-to-string"></a><h3>cr_rgb_to_string ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="returnvalue">guchar</span></a> *
cr_rgb_to_string (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>);</pre>
<p>Serializes the rgb into a zero terminated string.</p>
<p>Returns the zero terminated string containing the serialized
rgb. MUST BE FREED by the caller using <a href="https://developer.gnome.org/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.2.16.6.16.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> to serialize.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-dump"></a><h3>cr_rgb_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cr_rgb_dump (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> const *a_this</code></em>,
             <em class="parameter"><code><span class="type">FILE</span> *a_fp</code></em>);</pre>
<p>Dumps the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>
to a file.</p>
<div class="refsect3">
<a name="id-1.2.16.6.17.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the "this pointer" of
the current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>a_fp</p></td>
<td class="parameter_description"><p>the destination file pointer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cr-rgb-destroy"></a><h3>cr_rgb_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cr_rgb_destroy (<em class="parameter"><code><a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a> *a_this</code></em>);</pre>
<p>Destructor of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.16.6.18.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>a_this</p></td>
<td class="parameter_description"><p>the "this pointer" of the
current instance of <a class="link" href="libcroco-cr-rgb.html#CRRgb" title="struct CRRgb"><span class="type">CRRgb</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libcroco-cr-rgb.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CRRgb"></a><h3>struct CRRgb</h3>
<pre class="programlisting">struct CRRgb {
        /*
         *the unit of the rgb.
         *Either NO_UNIT (integer) or 
         *UNIT_PERCENTAGE (percentage).
         */
        const guchar *name ;
        glong red ;
        glong green ;
        glong blue ;
        gboolean is_percentage ;
	gboolean inherit ;
        gboolean is_transparent ;
        CRParsingLocation location ;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>